home *** CD-ROM | disk | FTP | other *** search
/ Software of the Month Club (Business) 1998 January / Software of the Month Club - Business Shareware (Volume 245) (January 1998).iso / dos / utility / see / see.doc < prev    next >
Text File  |  1996-07-18  |  73KB  |  1,588 lines

  1. ::TITLE
  2.  
  3.     ===========================================================================
  4.     ===========================================================================
  5.     ===========================                   =============================
  6.     ===========================                   =============================
  7.     ===========================        SEE        =============================
  8.     ===========================                   =============================
  9.     ===========================                   =============================
  10.     ===========================================================================
  11.     ===========================================================================
  12.  
  13.  
  14.  
  15.     SEE:  The ultra-configurable, macro-capable, file & hyperdoc viewer/printer
  16.  
  17.  
  18.  
  19.     ---------------------------------------------------------------------------
  20.     |                                                                         |
  21.     |     - Display online documentation                                      |
  22.     |     - Print all or part of a file                                       |
  23.     |     - Copy a file or extract selected portions                          |
  24.     |     - View enormous files -- megabytes long and 255 characters wide     |
  25.     |     - Support up to 3 printers, each with different setup strings       |
  26.     |     - Scan executables while filtering out most non-text data           |
  27.     |     - Read reports while filtering out printer control characters       |
  28.     |     - Combine hypertext and printable user manual into one hyperdoc     |
  29.     |     - Override configuration settings from the command line             |
  30.     |     - Feed keystrokes from the command line (macros)                    |
  31.     |     - Configure almost everything -- the setup help is very detailed    |
  32.     |     - Rearrange the pull-down menus and hotkeys to suit yourself        |
  33.     |     - Keep a library of alternative configurations and menu designs     |
  34.     |                                                                         |
  35.     ---------------------------------------------------------------------------
  36.  
  37.  
  38.  
  39.            Programs in the "SEE" package are Copyright (C) 1992, 1995 by
  40.            Pinnacle Software, CP 386 Mount Royal, Quebec, Canada H3P 3C6
  41.  
  42.            U.S. Office: Box 714 Airport Road, Swanton, Vermont 05488 USA
  43.            Support Line (514) 345-9578 --- Web Page www.cam.org/~pinnacl
  44.  
  45.  
  46.  
  47. ::OVERVIEW
  48.  
  49.     ===========================================================================
  50.                                USER MANUAL OVERVIEW
  51.     ===========================================================================
  52.  
  53.  
  54.     This manual contains the following sections:
  55.  
  56.  
  57.     INTRODUCTION
  58.     ------------
  59.     What is "SEE"?
  60.     Licensing
  61.     Upgrading from Earlier Versions
  62.  
  63.  
  64.     HOW TO USE SEE
  65.     --------------
  66.     Starting up
  67.       Wild cards
  68.       Cross-directory viewing
  69.       Monochrome (/M)
  70.       Overriding standard files (/C /U /S)
  71.       Summary of parameters and switches
  72.       Spaces in parameters
  73.     Reading files
  74.       Scrolling keys
  75.       Jump to a line
  76.       Find text
  77.       Textify
  78.       Copy part or all of a file
  79.       Function keys
  80.     Copying
  81.       Printer destination
  82.       Conversion
  83.  
  84.  
  85.     COMMAND-LINE MACROS
  86.     -------------------
  87.     Basic format (/K)
  88.     Special keys
  89.  
  90.  
  91.     HYPERDOCUMENTATION
  92.     ------------------
  93.     What is a Hyperdoc?
  94.     Printer Escape Sequence Filtering (/P)
  95.     No-Show Filtering (/N)
  96.     Topic Find (/F)
  97.     Quit Reading (/Q)
  98.     Examples
  99.     Copying versus /N and /P
  100.  
  101.  
  102.     CONFIGURING SEE
  103.     ---------------
  104.     Default and specified configurations
  105.     Multiple configurations (/C)
  106.     Changing the pull-down menus
  107.     Radical changes via the MNU files (/U)
  108.       Bottom line redefinition
  109.       Standard key remapping
  110.       SEE command tokens
  111.     Configuring from the command line (/O)
  112.       Copying operations
  113.       Status indications
  114.       Printer setups
  115.       Display control
  116.       Color settings
  117.       Complex example
  118.       Saving changes with the /W switch
  119.     Required files
  120.  
  121.  
  122.     ERROR CODES
  123.     -----------
  124.     Errors while reading MNU files
  125.     Errors generated by the /F parameter
  126.     Errors generated by the /O parameter
  127.     File errors
  128.     Summary of errorlevels
  129.  
  130.  
  131. ::INTRODUCTION
  132.  
  133.     ===========================================================================
  134.                                     INTRODUCTION
  135.     ===========================================================================
  136.  
  137.  
  138.                                    --------------
  139.                                    WHAT IS "SEE"?
  140.                                    --------------
  141.  
  142.     SEE is a utility for viewing and printing text files.  It can also display
  143.     hex files in a format that makes it easy for you to visually scan the file.
  144.     SEE also lets you extract portions of text from the listing.  The extracted
  145.     portion can be copied to the printer or to a text file.  SEE can also
  146.     serve as a hypertext engine for your application program, providing you
  147.     with a simple method for displaying and printing context-sensitive help.
  148.  
  149.  
  150.                                      ---------
  151.                                      LICENSING
  152.                                      ---------
  153.  
  154.  
  155.     This product is available in several forms.  For billing and pricing
  156.     information, view or print the file ORDER.FRM.
  157.     
  158.     TRIAL COPY:  If you have a "test-drive" evaluation copy, you will see a
  159.     "Registration Reminder Screen" when you start up the program.  You are
  160.     entitled to evaluate this program at no cost for 3 months.  If you continue
  161.     to use it after that, you must register your copy and purchase a license,
  162.     as described below.
  163.     
  164.     SINGLE-USER LICENSE:  When you register an evaluation copy of this product,
  165.     you will receive the latest version, plus an unlocking code that will let
  166.     you register any new evaluation versions that we release for a period of
  167.     two years (six years for deluxe registration).
  168.     
  169.     SITE/MULTI-COPY LICENSES:  If you plan to run 15 or more copies of this
  170.     program (on a network or on separate computers), you can obtain quantity
  171.     pricing.  For details, view or print the text file ORDER.FRM.
  172.     
  173.     LAN LICENSE:  Local Area Network users must purchase a license for each
  174.     user (see "Single-User License" and "Site/Multi-Copy Licenses"), although
  175.     they can reduce this amount if they have run-control software which sets an
  176.     upper limit on the number of concurrent users for a given program.
  177.     
  178.     WAN LICENSE:  Wide Area Networks are treated like LANs, but you may find it
  179.     more economical to purchase a Distribution License (see below).
  180.  
  181.     DISTRIBUTION LICENSE:  The distribution license allows you to use an
  182.     unlimited number of copies.  You may include it in your application or
  183.     commercial package as a utility.  The only restriction is that you may not
  184.     distribute this document (i.e. the user manual) or its essential content.
  185.     With this safeguard, we avoid placing ourselves in competition with you;
  186.     the program must be used to support an application or product rather than
  187.     being its main feature.
  188.     
  189.     SOURCE CODE LICENSE:  If you purchase the Turbo Pascal source code, you
  190.     must also purchase a license for each machine that will run the modified
  191.     program.  Those portions of the source code written by Pinnacle Software
  192.     remain copyrighted by Pinnacle, and may not be divulged to another party.
  193.     As an alternative to purchasing the source code, you can also contract for
  194.     us to make custom modifications to the program.
  195.     
  196.     RETAIL LICENSE:  You can sell complete, registered copies of this product,
  197.     complete with documentation, in return for royalties.  The terms depend on
  198.     volume and advance payments. Contact us for details.
  199.  
  200.  
  201.                           -------------------------------
  202.                           UPGRADING FROM EARLIER VERSIONS
  203.                           -------------------------------
  204.  
  205.     The configuration file (SEE.CFG) is compatible with the configuration files
  206.     from versions 2.01 onwards.  So if you have a configuration file from
  207.     version 2.01, 2.20 or 3.10 of SEE, it will still work.  Nevertheless, you
  208.     should run SEESETUP to see if there are any new configuration items you
  209.     would like to change.
  210.  
  211.     The "SEE" program was previously accompanied by some other utilities. The
  212.     GETKEY program is still included in the SEE package.  GETKEY is "freeware"
  213.     and may be given away as long as it is not altered in any way.  Some of the
  214.     other utilities (MIDNIGHT, SV) will be issued separately, at a later date,
  215.     in a different utilities collection.  The PSMENU_D program is included with
  216.     SEE, You are welcome to use it, subject to the distribution conditions.
  217.     Type PSMENU_D at the DOS prompt for details.
  218.  
  219.  
  220. ::HOWUSE
  221.  
  222.     ===========================================================================
  223.                                   HOW TO USE "SEE"
  224.     ===========================================================================
  225.  
  226.  
  227.                                   -----------
  228.                                   STARTING UP
  229.                                   -----------
  230.  
  231.     At the DOS command prompt, enter SEE followed by the name of the file you
  232.     want to view.  For example, the command:
  233.  
  234.     SEE SEE.DOC
  235.  
  236.     would display the file named SEE.DOC.
  237.  
  238.     SEE automatically detects the type of file being viewed and selects the
  239.     appropriate display mode (standard text or "raw-text" for binary files).
  240.  
  241.  
  242.     ---------
  243.     WILDCARDS
  244.     ---------
  245.  
  246.     If you specify a "DOS Wildcard", you will see a menu of file names that
  247.     match. You can move the cursor to the file you want by using your arrow
  248.     keys, then press Enter to see the file.
  249.  
  250.     For example:
  251.  
  252.     SEE *.INF
  253.  
  254.     would show you all files with the extension INF.
  255.  
  256.     If you omit any file specification, SEE assumes you mean *.* so that the
  257.     following command would let you select from all files in the current
  258.     directory:
  259.  
  260.     SEE
  261.  
  262.  
  263.     -----------------------
  264.     CROSS-DIRECTORY VIEWING
  265.     -----------------------
  266.  
  267.     SEE normally looks for the files in your current drive and directory.
  268.     However, you can look at another drive or directory by specifying the path
  269.     name accordingly, as in this example:
  270.  
  271.     SEE D:\MYDIR\ACCOUNTS\PAYROLL.TXT
  272.  
  273.  
  274.     ----------
  275.     MONOCHROME
  276.     ----------
  277.  
  278.     SEE can normally detect if you have a color display card or not, but no DOS
  279.     program can detect if your monitor can actually display color.  (Some
  280.     people have color display cards with monochrome monitors)  If SEE is
  281.     displaying text in color and you want to force it to display in monochrome,
  282.     add  /M  to the command line.  For example:
  283.  
  284.     SEE MYFILE.TXT /M
  285.  
  286.     This would display the file MYFILE.TXT in black and white.
  287.  
  288.     You can configure SEE (using the SEESETUP program) to always start up in
  289.     monochrome mode.  This will save you the bother of always having to specify
  290.     the /M parameter.
  291.  
  292.  
  293.     -------------------------
  294.     OVERRIDING STANDARD FILES
  295.     -------------------------
  296.  
  297.     In normal operation, SEE uses a standard set of support files, but you can
  298.     override them and use files you have prepared yourself...
  299.  
  300.     STANDARD
  301.     FILES      DESCRIPTION      OVERRIDE FORMAT       EXAMPLE
  302.     --------   --------------   -------------------   ------------------------
  303.     SEE.MNU    Menu layout      SEE file /Ufilename   SEE XYZ.DOC /uMYMENU.MNU
  304.     SEE.CFG    Configuration    SEE file /Cfilename   SEE XYZ.DOC /cMYCONF.CFG
  305.     SEE.SBx    Help (SBI/SBT)   SEE file /Srootname   SEE XYZ.DOC /sMYHELP
  306.  
  307.     You do not have to specify the file extension for the /C and /U parameters;
  308.     SEE will assume CFG or MNU as appropriate.  Also, both /C and /U let you
  309.     place the file in another directory, if you specify the full path.  If you
  310.     do not specify a full directory path, SEE will look first in the current
  311.     directory, and then in the directory where the SEE.EXE program is located.
  312.  
  313.     Configuration files do not require the CFG extension.  Menu files do not
  314.     require the MNU extension.  However, it may make it easier to keep track of
  315.     your files if you use these standard extensions.
  316.  
  317.     The program SEESETUP also recognizes the /C parameter. When you use /C with
  318.     with SEE and you call up SEESETUP (General/Setup via the pull-down menu, or
  319.     Alt-Z via the shortcut key) it passes the correct configuration file name
  320.     to SEESETUP.
  321.  
  322.     The help files (SBI/SBT) can be prepared only with a special program named
  323.     SBX.  This program comes with the source code or distribution license. The
  324.     help files must be placed in the same directory as the SEE.EXE program.
  325.  
  326.  
  327.     ----------------------------------
  328.     SUMMARY OF PARAMETERS AND SWITCHES
  329.     ----------------------------------
  330.  
  331.     Here is a brief summary of the command-line switches:
  332.  
  333.     FORMAT OF COMMAND      FUNCTION
  334.     ---------------------- ----------------------------------------------------
  335.     SEE file /Cfilename    Specifies alternative configuration (CFG) file
  336.     SEE file /Ftext        Finds the specified text
  337.     SEE file /Kkey-list    Stacks keys to be "pressed automatically" ("macros")
  338.     SEE file /M            Switches on monochrome (black and white) display
  339.     SEE file /Nprefix-list Lists up to five prefixes for "no-show" lines
  340.     SEE file /N            Enables the preconfigured "no-show" prefixes
  341.     SEE file /Oconfig-list Temporarily modifies one or more configuration items
  342.     SEE file /P            Switches on printer-code filtering
  343.     SEE file /Qtext        Stops reading in text when specified text is found
  344.     SEE file /Q            Stops reading in text when a /N prefix is found
  345.     SEE file /Srootname    Specifies alternative help (SBI/SBT) files
  346.     SEE file /Ufilename    Specifies alternative menu (MNU) file
  347.     SEE file /W            Saves modifications specified by the /O parameter
  348.     SEE file /X            Switches on raw text (binary file) display mode
  349.         |
  350.         |
  351.     This can be a file (e.g. XYZ.TXT) or a wildcard file mask (e.g. *.TXT).  If
  352.     you omit the "file" part, SEE assumes you mean *.* (which means "every file
  353.     in the current directory) and will show you a menu.
  354.  
  355.     You can use several parameters and switches in the same command:
  356.  
  357.     SEE XYZ.TXT /cMYFILE.CFG /fHELLO /qGOODBYE
  358.  
  359.     Some parameters are not compatible, however.  You can not mix the /P and
  360.     the /X parameter (printer-code filtering is not available in raw text
  361.     mode). Also, the /W switch has no value unless used with the /O parameter.
  362.  
  363.     If you omit the "file" part of the command and use both the /O and /W
  364.     parameters, SEE can modify and save configuration items from the command
  365.     line without displaying anything (unless there is an error).  See the
  366.     section "Configuring from the Command Line", which describes /O and /W in
  367.     detail.
  368.  
  369.  
  370.     --------------------
  371.     SPACES IN PARAMETERS
  372.     --------------------
  373.  
  374.     If you are passing a parameter that has a space in it, you must enclose
  375.     the information in quotes.  For example:
  376.  
  377.     SEE MYDOC.TXT /F"Mr. Jones"
  378.  
  379.     If you require a quote inside the parameter information, you must use
  380.     doubled-up quotes:
  381.  
  382.     SEE MYDOC.TXT /F"Mr. ""Ace"" Jones"
  383.  
  384.  
  385.                                    -------------
  386.                                    READING FILES
  387.                                    -------------
  388.  
  389.  
  390.     --------------
  391.     SCROLLING KEYS
  392.     --------------
  393.  
  394.     Once you have selected the file you want to read, you can scroll back and
  395.     forth in the file a line at a time, using the arrow keys.  You can also
  396.     jump back and forth a screen at a time, using the PgUp and PgDn keys.
  397.  
  398.     The Home and End keys position the file to the beginning and end,
  399.     respectively.
  400.  
  401.     The spacebar key moves forward one screen each time it is pressed.  When
  402.     you reach the end of the file, you are returned to the previous operation
  403.     (i.e. the file selection menu, if you started SEE with DOS wildcards, or
  404.     the DOS prompt otherwise).
  405.  
  406.     The left and right-arrow keys scroll text left and right one character at a
  407.     time.  You can use these keys in conjunction with the Ctrl key to scroll
  408.     five characters at a time.
  409.  
  410.  
  411.     ---------
  412.     THE L KEY  --  Jump to a line
  413.     ---------
  414.  
  415.     The L key will ask you for a line number.  It will then jump to that line,
  416.     positioning it at the first line of the viewing area.
  417.  
  418.  
  419.     ---------
  420.     THE F KEY  --  Find text
  421.     ---------
  422.  
  423.     The F key will ask you for a text string.  If it finds that string in the
  424.     text, it will jump there, highlighting the line the text is on.  The line
  425.     is positioned in the middle of the screen, if possible.
  426.  
  427.     To search for the same text again, press the F3 function key.  To search
  428.     backwards to a previously found line, press the F4 function key.
  429.  
  430.  
  431.     -------------
  432.     THE ALT-Y KEY  --  Textify
  433.     -------------
  434.  
  435.     The ALT-Y key lets you filter the display of data in "binary" (non-text)
  436.     files such that only the words (and a little bit of extraneous material)
  437.     show up.  This is useful for scanning a program or data file for helpful
  438.     information, while removing most of the material that is intelligible only
  439.     to the computer.
  440.  
  441.     The textify function only works in raw binary display mode.  You can force
  442.     SEE to use this display mode by starting it up with the  /X  switch, as in
  443.     this example:
  444.  
  445.     SEE MYFILE.DAT /X
  446.  
  447.     In most cases this will not be necessary, since SEE automatically detects
  448.     the difference between binary and text files.
  449.  
  450.  
  451.     ---------
  452.     THE C KEY  --  Copy part or all of the file to printer or file
  453.     ---------
  454.  
  455.     The C key sends a copy of the file (or part of it) to your printer, or to
  456.     another file.  See the section entitled "Copying" for details.
  457.  
  458.     While using the C feature, remember that the Esc key will always return you
  459.     to your previous operation.  If you were looking at the help screens, it
  460.     returns you to the viewing window.  If you were viewing text, it returns
  461.     you to the file selection menu (if you started SEE with DOS wildcards) or
  462.     the DOS prompt otherwise.
  463.  
  464.     The Copy command asks many questions in order to determine what you want to
  465.     do.  To save time, you can use the SEESETUP program to specify default
  466.     values to these questions, or skip them altogether (using a preselected
  467.     value).
  468.  
  469.  
  470.     -----------------
  471.     THE FUNCTION KEYS
  472.     -----------------
  473.  
  474.     F 1  displays the help screens.  See "Quick Help", above, for additional
  475.          information about these screens.
  476.  
  477.     F 2  displays a "ruler" line, which lets you determine in which column text
  478.          starts and ends.
  479.  
  480.     F 3  repeats the last Find operation (see "The F Key", above).
  481.  
  482.     F 4  repeats the last Find operation, but looks backwards
  483.  
  484.     F 5  switches the display to 25 lines, in monochrome.
  485.  
  486.     F 6  switches the display to 25 lines, in color.
  487.  
  488.     F 7  switches the display to smaller letters, in monochrome, if you have
  489.          the appropriate display card.  If you have a CGA, Hercules or MCGA
  490.          card, nothing will happen.  If you have an EGA card, you will see 43
  491.          lines on your screen.  A VGA display card will display 50 lines.
  492.  
  493.     F 8  does what the F7 key does, but uses color instead of monochrome.
  494.  
  495.     F 9  sends a page eject character (ASCII 12, Hex $0C) to the printer.  You
  496.          can select the printer number.  By default it is printer LPT1 (or the
  497.          default printer number specified by SEESETUP).
  498.  
  499.     F10  calls up a menu for selecting SEE functions.  This takes a little
  500.          longer than pressing a single letter key, but is easier to remember!
  501.          The menu also includes a Help section which explains various SEE
  502.          capabilities.
  503.  
  504.  
  505.                                       -------
  506.                                       COPYING
  507.                                       -------
  508.  
  509.  
  510.     When you are viewing a file and you press the C (Copy) key, SEE will ask
  511.     you a few questions, then copy part (or all) of the file to the printer, or
  512.     to another file.
  513.  
  514.     The questions let you specify:
  515.  
  516.     PORTION:      Which part of the file (some, or all) should be copied.
  517.  
  518.     DESTINATION:  Which printer you want to print to (LPT1, LPT2 etc.) or which
  519.                   file you want to copy to (e.g. SAVE.TXT). If the file already
  520.                   exists, you can overwrite it, or add to the end.
  521.  
  522.     The following two questions apply to printing only:
  523.  
  524.     CONVERSION:   Whether to convert extended characters or not.
  525.  
  526.     FORM-FEED:    Whether the printer should "page eject" after printing.
  527.  
  528.     The printer questions are discussed in more detail, below.
  529.  
  530.     NOTE:  Before you start printing, make sure your printer is turned on, is
  531.     supplied with paper, and that the "Online" light is lit.  (On some
  532.     printers, the Online light may be labelled "Ready", or something similar.
  533.     Refer to your printer manual if you are not sure.)
  534.  
  535.     If at any time you wish to exit from the copying process, you can press the
  536.     Esc key.  If you were printing, you may have to turn your printer OFF for a
  537.     moment, then ON again, to reset it and clear its memory.
  538.  
  539.     The Copy command asks many questions in order to determine what you want to
  540.     do.  To save time, you can use the SEESETUP program to specify default
  541.     values to these questions, or skip them altogether (using a preselected
  542.     value).
  543.  
  544.  
  545.     -------------------
  546.     PRINTER DESTINATION
  547.     -------------------
  548.  
  549.     When you are asked to select a printer destination, choose the address of
  550.     the printer to which you are copying the text.  You can choose any printer
  551.     from LPT1 to LPT9.  (It is somewhat unusual to have a printer with an
  552.     address higher than LPT2.)
  553.  
  554.     If you are not sure, select LPT1.  Most PC-compatible computers have their
  555.     printer at that address.  Exception:  if your computer is sharing the
  556.     printer with other computers on a network, check with your network manager
  557.     before proceeding.
  558.  
  559.  
  560.     ----------
  561.     CONVERSION
  562.     ----------
  563.  
  564.     Many documents (such as this one) make use of the special characters that
  565.     are available on IBM-PC compatible computers.  Some printers, though
  566.     (particularly older printers and very high speed printers), can not print
  567.     these characters properly.
  568.  
  569.     If when you print, many of the characters come out wrong, you may have to
  570.     have them "converted".  The conversion process replaces these characters
  571.     with a "reasonable" substitution before printing them.  (Note that this
  572.     affects only the printing; the document you are viewing is NOT changed.)
  573.  
  574.     For example, accented letters can not be printed on all printers.  So an
  575.     accented "e" would be printed simply as "e", with no accent.  Line-drawing
  576.     characters (for boxes) are also a problem for some printers.  So the
  577.     vertical line character is replaced with the standard "split bar"
  578.     character, which looks almost the same.
  579.  
  580.  
  581.  
  582. ::MACROS
  583.  
  584.     ===========================================================================
  585.                                COMMAND-LINE MACROS
  586.     ===========================================================================
  587.  
  588.  
  589.                                     ------------
  590.                                     BASIC FORMAT
  591.                                     ------------
  592.  
  593.     When you start up SEE at the DOS prompt,  you can "stack" keys with the /K
  594.     parameter, as in this example:
  595.  
  596.     SEE SEE.DOC /K{END}
  597.  
  598.     This would display the file SEE.DOC in the usual way,  but would "press"
  599.     the  End  key to jump to the end of the file.
  600.  
  601.  
  602.                                     ------------
  603.                                     SPECIAL KEYS
  604.                                     ------------
  605.  
  606.     Special keys are entered using codes in brace parentheses, as follows:
  607.  
  608.     {SPC}   Space               {CR}    Enter                {ESC}   Escape
  609.     {F1}    F1                  {F2}    F2                   {F3}    F3 (etc.)
  610.     {UP}    Up arrow            {DN}    Down arrow           {HOME}  Home
  611.     {LF}    Left arrow          (RT}    Right arrow          {END}   End
  612.     {CTLF}  Ctrl-Left Arrow     {CTRT}  Ctrl-Right Arrow     {CHOM}  Ctrl-Home
  613.     {PGUP}  PgUp                {PGDN}  PgDn                 {CEND}  Ctrl-End
  614.     {CPGD}  Ctrl-PgDn           {HOME}  Home                 {LBRC}  {
  615.     {TAB}   Tab                 {BTAB}  Shift (back) Tab     {RBRC}  }
  616.  
  617.     Standard keys (i.e. those you can type) can be entered directly.  Most keys
  618.     can also be entered as decimal ASCII values.  Thus, you could enter the
  619.     {CR} (Carriage Return) code as {13}.
  620.  
  621.     This method does NOT work for all values above ASCII 128, some of which
  622.     are used internally by SEE to represent Alt-Letter keys and mouse activity.
  623.     For example, Alt-D is represented by {160}.  SEE XYZ.TXT /K{160}R would
  624.     select "Display/Ruler".  For a list of the special values, see the files
  625.     SEE.MNU and SEESAMPL.MNU.
  626.  
  627.  
  628.  
  629. ::HYPER
  630.  
  631.     ===========================================================================
  632.                                  HYPERDOCUMENTATION
  633.     ===========================================================================
  634.  
  635.  
  636.                                 -------------------
  637.                                 WHAT IS A HYPERDOC?
  638.                                 -------------------
  639.  
  640.     Many software products are accompanied by:
  641.  
  642.     - A READ.ME file which gives general instructions
  643.     - A printable manual on the diskette
  644.     - A program to print the manual
  645.     - Context-sensitive help within the software product
  646.     - Text for the context-sensitive help
  647.  
  648.     SEE can combine all of these functions, replacing the items above with:
  649.  
  650.     - SEE.EXE (The SEE program)
  651.     - A printable user manual containing hypertext labels
  652.  
  653.     An optional item is the file SEE.CFG, which can contain specific config-
  654.     uration information.
  655.  
  656.     SEE can use its /P and /N parameters to display the user manual on the
  657.     screen, while suppressing the printer and hypertext codes it contains.  The
  658.     CFG file contains information about the codes used.  (If the CFG file is
  659.     not present, SEE assumes the document uses EPSON FX printer codes, and uses
  660.     the prefix :: for hypertext labels.)
  661.  
  662.     Your program can also call up SEE, using the /P /N /F and /Q parameters, to
  663.     zero in on a particular topic within the manual.  For example, your program
  664.     could pass this command to DOS:
  665.  
  666.     SEE SEE.DOC /P /N!:: /F::HYPER /Q
  667.  
  668.     This would do the following:
  669.  
  670.     - Suppress printer codes
  671.     - Suppress display on hypertext codes (e.g. ::HYPER)
  672.     - Stop reading when the next hypertext code (or end of file) is found
  673.  
  674.     Thus, the user would be able to use all the normal SEE functions within a
  675.     subset of the standard document.
  676.  
  677.     This document (SEE.DOC) uses printer codes (i.e. the Form Feed character)
  678.     and hypertext codes (e.g. ::HYPER), so you can try the command given above
  679.     to see how it works.
  680.  
  681.  
  682.                        --------------------------------------
  683.                        PRINTER ESCAPE SEQUENCE FILTERING (/P)
  684.                        --------------------------------------
  685.  
  686.     An "Escape Sequence" is a string of characters which begin with a
  687.     particular character (usually the Escape character -- ASCII 27).  When a
  688.     printer sees this character, it inspects one or more of the following bytes
  689.     to determine what it should do (change fonts, start underlining etc.).
  690.  
  691.     If you are viewing a document that contains printer escape sequences, you
  692.     can filter most of them out by turning on Printer Escape Sequence
  693.     Filtering. There are three ways to do this:
  694.  
  695.     - Press F10 to call up the menu, then select Printer/Filter Codes
  696.     - Press the shortcut key Alt-F
  697.     - Start up SEE with the /P command-line switch (e.g. SEE MYFILE.PRN /P)
  698.  
  699.     Filtering only works in standard text mode.  If you are in raw text mode
  700.     (i.e. you started up SEE with the /X switch, or SEE did not recognize the
  701.     file as a text file), filtering is disabled.
  702.  
  703.     When you are filtering, SEE will also skip any characters below ASCII 32,
  704.     since these are non-display characters that are usually used to control the
  705.     printer.  For example, ASCII 12 (Ctrl-L) is almost always used to mean
  706.     "eject page".
  707.  
  708.     If the file you are viewing was prepared for some other printer, you can
  709.     modify the sequences that SEE recognizes.  You can either use a predefined
  710.     setup (shipped with SEE as files with a PRT extension) or type in your own.
  711.     To type in or load new definitions, start up SEESETUP and select "Printer
  712.     Escape Sequences Filter".
  713.  
  714.     Setting up new filtering specifications requires an intimate knowledge of
  715.     the printer you are using.  You can, however, find some helpful information
  716.     by positioning your cursor on any of the fields in the "Printer Escape
  717.     Sequences Filter" screen and pressing F1.  You can also view the file
  718.     EPSONFX.PRT (supplied with the standard edition of SEE) to find out how you
  719.     can create your own printer definition files, using only a text editor.
  720.  
  721.  
  722.                                ----------------------
  723.                                NO-SHOW FILTERING (/N)
  724.                                ----------------------
  725.  
  726.     SEE lets you define up to five "No-Show Prefixes".  A No-Show Prefix is a
  727.     sequence of up to 10 characters which, if found in column one of a
  728.     document, will suppress the display of that line (provided you have enabled
  729.     No-Show, using the /N parameter).
  730.  
  731.     The text file SEE.DOC, which is included in the standard SEE package,
  732.     contains several lines which begin with a :: sequence.  These are used as
  733.     "labels", and the batch file START.BAT (included with SEE) uses them (via
  734.     the batch file VIEW.BAT) to display portions of this manual.  (To try out
  735.     the START.BAT file, switch to your SEE directory and type START at the DOS
  736.     prompt.  Then select INFO to view SEE.DOC.)
  737.  
  738.     To jump to the "CONFIGURING SEE" section of SEE.DOC, you would enter the
  739.     following command:
  740.  
  741.     SEE SEE.DOC /P /N!:: /F::HYPER
  742.  
  743.     The /P switch filters printer codes -- SEE.DOC contains the form feed
  744.     character (ASCII 12) at the beginning of each new page.  The /N parameter
  745.     defines the "No-Show" prefix (i.e. ::).  The /F parameter (which is
  746.     discussed later in more detail) finds the ::HYPER label.  Since we are in
  747.     No-Show mode (because of the /N parameter), SEE will display the first
  748.     visible line that follows the label.
  749.  
  750.     The format of the /N parameter is:
  751.  
  752.     /N delimiter code1 [delimiter code2] ... [delimiter code5]
  753.  
  754.     For example, to set three No-Show prefixes (@@, ## and $$):
  755.  
  756.     SEE XYZ.DOC /N-@@-##-$$
  757.  
  758.     The "delimiter" part of the command is important:  you must use a character
  759.     that does not appear in the any of the prefixes, since the delimiter is
  760.     being used to separate the prefixes.  Any character can be used as a
  761.     delimiter, except | < and > (which have a special meaning to DOS) and the
  762.     quote character ("), which has a special meaning to SEE (see the section
  763.     entitled "Spaces in Parameters").
  764.  
  765.     If you entered the command above, any lines that started with @@, ## or $$
  766.     would not be displayed.  Nor could they be copied (using SEE's copying
  767.     functions) or printed.  The only way they can be accessed is through the /F
  768.     and /Q parameters.
  769.  
  770.     If you do not specify any prefixes for /N, SEE will look in the config-
  771.     uration file (SEE.CFG) for the list of No-Show Prefixes.  Run SEESETUP to
  772.     set these.  If SEE does not find any prefixes there, it will assume a
  773.     default :: prefix.
  774.  
  775.  
  776.                                   ---------------
  777.                                   TOPIC FIND (/F)
  778.                                   ---------------
  779.  
  780.     The /F parameter finds the specified text (up to 80 characters long).  The
  781.     simplest case works like this:
  782.  
  783.     SEE XYZ.TXT /FTHE
  784.  
  785.     This would find the first occurance of the word "THE", and highlight it in
  786.     the middle of the screen.  If you are looking for something that has a
  787.     space in it, you have to enclose the specification in quotes:
  788.  
  789.     SEE XYZ.TXT /F"THE DOG"
  790.  
  791.     This would find the first occurance of "THE DOG".  All searches are
  792.     case-insensitive.  Note:  due to the way DOS command-line parameters are
  793.     parsed, it is not possible to search for double spaces.  Thus, the command
  794.  
  795.     SEE XYZ.TXT /F"THE DOG.  ROVER WAS HIS NAME."
  796.  
  797.     would not work; the two spaces are treated as a single space.
  798.  
  799.     The /F parameter is useful when used in conjunction with the /N parameter,
  800.     since this forms the basis of SEE's hyperdoc capabilities.  For example:
  801.  
  802.     SEE XYZ.TXT /N!@@ /F@@CHAPTER2
  803.  
  804.     The /N parameter puts SEE into No-Show mode and suppresses any lines that
  805.     begin with the @@ sequence.  The /F parameter looks for the first line that
  806.     reads "@@CHAPTER2" and goes there.  Since we are in No-Show mode and the
  807.     line we found is a No-Show line, SEE displays the next visible line at the
  808.     TOP of the screen (not the middle, as in the simple example given before).
  809.  
  810.     Thus, you could set up a file named ABC.DOC like this:
  811.  
  812.     ::TITLEPAGE
  813.     (Text)
  814.     ::CHAPTER1
  815.     (Text)
  816.     ::CHAPTER2
  817.     (Text)
  818.     ::INDEX
  819.     (Text)
  820.  
  821.     Then, you could jump to the top of any of the sections with one of these
  822.     commands:
  823.  
  824.     SEE ABC.DOC /N!:: /F::TITLEPAGE
  825.     SEE ABC.DOC /N!:: /F::CHAPTER1
  826.     SEE ABC.DOC /N!:: /F::CHAPTER2
  827.     SEE ABC.DOC /N!:: /F::INDEX
  828.  
  829.     If any of the labels contains spaces, you must enclose the specification in
  830.     quotes.  For example, if the document is set up like this:
  831.  
  832.     @@TITLE PAGE
  833.     (Text)
  834.     @@CHAPTER 1
  835.     (Text)
  836.     @@CHAPTER 2
  837.     (Text)
  838.     @@INDEX SECTION
  839.     (Text)
  840.  
  841.     then you would use these commands:
  842.  
  843.     SEE ABC.DOC /N!@@ /F"@@TITLE PAGE"
  844.     SEE ABC.DOC /N!@@ /F"@@CHAPTER 1"
  845.     SEE ABC.DOC /N!@@ /F"@@CHAPTER 2"
  846.     SEE ABC.DOC /N!@@ /F"@@INDEX SECTION"
  847.  
  848.     If your document contains printing codes, such as form feeds, you can
  849.     include the /P switch to suppress them.  For example:
  850.  
  851.     SEE ABC.DOC /N!@@ /F"@@TITLE PAGE" /P
  852.  
  853.  
  854.                                  -----------------
  855.                                  QUIT READING (/Q)
  856.                                  -----------------
  857.  
  858.     The /Q parameter is the "other half" of the /F parameter.  Once /F has
  859.     found its text, /Q tells SEE where to stop reading.  Let's say you set up
  860.     the document ABC.DOC as follows:
  861.  
  862.     ::TITLEPAGE
  863.     (Text)
  864.     ::CHAPTER1
  865.     (Text)
  866.     ::CHAPTER2
  867.     (Text)
  868.  
  869.     If you entered this command:
  870.  
  871.     SEE ABC.DOC /N!:: /F::CHAPTER1
  872.  
  873.     then SEE would position itself at the top of Chapter 1.  However, all the
  874.     text after it would be available -- including Chapter 2.  If you want to
  875.     display only Chapter 1, enter this command:
  876.  
  877.     SEE ABC.DOC /N!:: /F::CHAPTER1 /Q
  878.  
  879.     Used in this way, /Q means "Stop when you reach the next No-Show line".
  880.  
  881.     You can also add a parameter to /Q, to indicate specific text.  Let's say
  882.     you wanted to display the Title Page and all of Chapter 1.  You could enter
  883.     this command:
  884.  
  885.     SEE ABC.DOC /N!:: /F::TITLEPAGE /Q::CHAPTER2
  886.  
  887.     This would position SEE at the top of the Title Page, but would not allow
  888.     the user to go past the end of Chapter 1.
  889.  
  890.     The /Q specification does not have to be a No-Show line.  For example, the
  891.     following command is valid:
  892.  
  893.     SEE MYFILE.TXT /F"THE DOG" /Q"THE CAT"
  894.  
  895.     This would position the line containing "THE DOG" near the middle of the
  896.     screen, but would not show any text after the line containing "THE CAT".
  897.  
  898.  
  899.                                       --------
  900.                                       EXAMPLES
  901.                                       --------
  902.  
  903.     Here are some examples of the /N /F /Q and /P parameters...
  904.  
  905.     COMMAND                             WHAT IS DISPLAYED
  906.     ----------------------------------- ---------------------------------------
  907.     SEE SEE.DOC /P                      All of file; no printer codes
  908.     SEE SEE.DOC /N!::                   All of file, suppressing :: lines
  909.     SEE SEE.DOC /N                      All (See NOTE #1)
  910.     SEE SEE.DOC /N /F::INTRO /Q::HOWUSE From INTRO section to start of HOWUSE
  911.     SEE SEE.DOC /N /F::INTRO /Q         From INTRO section to next No-Show line
  912.     SEE SEE.DOC /N /F /Q::HOWUSE        From beginning, to start of HOWUSE
  913.     SEE SEE.DOC /N /Q::HOWUSE           Same as above
  914.     SEE SEE.DOC /N /F::HOWUSE           From start of HOWUSE section to end
  915.     SEE SEE.DOC /N /F /Q                All of file
  916.     SEE SEE.DOC /Fthe /Qupload          From first "THE" to the next "UPLOAD"
  917.     SEE SEE.DOC /Fthe /Q                From first "THE" to the end of file
  918.  
  919.     NOTE #1:  If you use /N by itself (i.e. no prefixes specified), SEE will
  920.               look in the configuration file for the default No-Show Prefixes
  921.               you specified via SEESETUP.  If the configuration (CFG) file is
  922.               not found, or no prefixes were set, SEE will assume a :: No-Show
  923.               Prefix.
  924.  
  925.     NOTE #2:  The /N /F /Q and /P parameters are ignored if you use the /X
  926.               switch (which means "display file in raw-text mode").
  927.  
  928.  
  929.                               ------------------------
  930.                               COPYING VERSUS /N AND /P
  931.                               ------------------------
  932.  
  933.     If the user copies part or all of the file while /N or /P are in effect,
  934.     SEE tries to make a reasonable choice about what to copy.
  935.  
  936.     If /N is in effect, no No-Show lines will be copied.
  937.  
  938.     If /P is in effect, SEE will suppress printer codes if the destination is a
  939.     file.  If the destination is a printer, SEE will send the printer codes.
  940.  
  941.  
  942.  
  943. ::CONFIG
  944.  
  945.     ===========================================================================
  946.                                  CONFIGURING "SEE"
  947.     ===========================================================================
  948.  
  949.  
  950.                         ------------------------------------
  951.                         DEFAULT AND SPECIFIED CONFIGURATIONS
  952.                         ------------------------------------
  953.  
  954.     Even if you do not pre-configure SEE, it will try to pick reasonable values
  955.     for all of its operations.  For example, it will detect the kind of display
  956.     card you have and choose color or monochrome mode accordingly, using the
  957.     same number of lines per screen that you had set before you called up SEE.
  958.  
  959.     However, you may wish to change some of the selections.  You can create a
  960.     configuration file (named SEE.CFG) using the SEESETUP configuration program
  961.     (SEESETUP.EXE).
  962.  
  963.  
  964.                             ----------------------------
  965.                             MULTIPLE CONFIGURATIONS (/C)
  966.                             ----------------------------
  967.  
  968.     When SEE starts up, it looks in the current (i.e. logged) drive and
  969.     directory for a file named SEE.CFG.  If it does not find it there, it looks
  970.     in the SEE home directory (i.e. where the SEE.EXE file is located) for the
  971.     file.  If it finds the file, it uses the values it specifies.  If it does
  972.     NOT find it (in either the logged or home directory), SEE uses reasonable
  973.     default values that are appropriate for virtually all machines.
  974.  
  975.     CFG files are created with the SEESETUP program.  To start up SEESETUP,
  976.     enter SEESETUP at the DOS prompt, or select "Setup" on the SEE pull-down
  977.     menu.  Each configuration screen can provide you with detailed explanations
  978.     of each configuration option -- press F1 whenever you need additional
  979.     information.
  980.  
  981.     If you create several different CFG files, you can specify which one should
  982.     be used, when you start up SEE, by using the /C parameter.  For an explana-
  983.     tion of this parameter, see "Overriding Standard Files" in the "How to Use
  984.     SEE" section of this manual.
  985.  
  986.  
  987.                             ----------------------------
  988.                             CHANGING THE PULL-DOWN MENUS
  989.                             ----------------------------
  990.  
  991.     The pull-down menus are fully configurable.  To change them, make a backup
  992.     copy of the file SEE.MNU, then load SEE.MNU into a text editor.  The file
  993.     contains complete details for modifying the menus.
  994.  
  995.  
  996.                        --------------------------------------
  997.                        RADICAL CHANGES VIA THE MNU FILES (/U)
  998.                        --------------------------------------
  999.  
  1000.     The /U command line parameter lets you select an alternative menu (MNU)
  1001.     file to suit the operation at hand.  For example, you might decide to
  1002.     create an MNU file that eliminates certain commands that are not necessary
  1003.     for the current application, or perhaps you simply want to remove functions
  1004.     that you think would confuse the end user.
  1005.  
  1006.     Using alternative MNU files, you can radically change the way SEE behaves.
  1007.     You can:
  1008.  
  1009.     - Move around the position of items in the pull-down menus
  1010.     - Eliminate options from the pull-down menus
  1011.     - Set new status lines (the lines that appear at the bottom of the screen)
  1012.     - Redefine shortcut keys
  1013.     - Remap standard keys to call up other functions
  1014.  
  1015.     By using the /U and /C command-line parameters together, you can make SEE
  1016.     work the way YOU want it to, and you can define different behaviours for
  1017.     different situations.
  1018.  
  1019.     Some of these changes are called "radical" changes, because they make SEE
  1020.     work in a manner that is vastly different from its standard operation.
  1021.     Below, we will discuss "Bottom Line Redefinition" and "Standard Key
  1022.     Remapping".  For examples of both techniques, see the file SEESAMPL.MNU.
  1023.                        
  1024.     ------------------------
  1025.     BOTTOM LINE REDEFINITION
  1026.     ------------------------
  1027.  
  1028.     You can place a [BOTTOM LINES] section in the MNU file after the standard
  1029.     pull-down menu definition.  It defines bottom "help" lines (i.e. the lines
  1030.     which appear on the last line of the main viewing screen).  If these appear
  1031.     in the MNU file, they override the bottom lines that appear in the CFG file
  1032.     (as configured via the SEESETUP program).  You can override any or all of
  1033.     the bottom line definitions.  These will also override the default
  1034.     definitions that are used if the CFG file is missing.
  1035.  
  1036.     BLTOP sets the line displayed at the top of the file
  1037.     BLEND sets the line displayed at the end of the file
  1038.     BLMID sets the line displayed in between
  1039.     BLALL sets the line displayed when the entire file fits on one screen
  1040.  
  1041.     Here is an example of a [BOTTOM LINES] section:
  1042.  
  1043.     [BOTTOM LINES]
  1044.     BLTOP | {32} {25}  {27} {26}         PgDn          End          Esc = Quit
  1045.     BLMID | {24} {25}  {27} {26}   PgUp  PgDn    Home  End          Esc = Quit
  1046.     BLEND | {24} {32}  {27} {26}   PgUp          Home               Esc = Quit
  1047.     BLALL | (Entire file displayed)                                 Esc = Quit
  1048.  
  1049.     As you can see, you may use {symbols}, just as you do when defining the
  1050.     bottom lines in the SEESETUP program.  For example, you can't type the
  1051.     following characters, but you can use a {symbol} to represent them:
  1052.  
  1053.     {24} = Up arrow  {25} = Down arrow  {27} = Left arrow  {28} = Right arrow
  1054.  
  1055.     The definition for each line begins immediately after the | delimiter.
  1056.     You will notice that in the example, we used the symbol {32} (i.e. space)
  1057.     to ensure that the definitions line up nicely when a character was replaced
  1058.     by a space.  This makes it easier to visualize how the line will look after
  1059.     the symbols are resolved.
  1060.  
  1061.     The maximum length of a definition line (including the name [e.g. BLMID]
  1062.     and the | delimiter) is 255 characters.  After all the symbols are resolved
  1063.     (e.g. {24} is replaced by an up arrow), the line must be 80 characters or
  1064.     less, so that it can fit on the screen.
  1065.  
  1066.     Note that the [BOTTOM LINES] label must be present in order for these
  1067.     definitions to be recognized.  To see the [BOTTOM LINES] section in an
  1068.     actual MNU file, see the file SEESAMPL.MNU.
  1069.  
  1070.     ----------------------
  1071.     STANDARD KEY REMAPPING
  1072.     ----------------------
  1073.  
  1074.     SEE normally maps certain standard keys (e.g. "A", "B", "C") to particular
  1075.     functions.  For example, by default the "A" key stands for "find Again".
  1076.     These are NOT the same as the shortcut keys defined in the standard MNU
  1077.     definition, which generally use ALT or function keys.
  1078.  
  1079.     One advantage of supporting standard keys is that you can disable a
  1080.     function from the menu (so the user doesn't know about it) but still use
  1081.     it.  This lets support personnel use functions that are apparently not
  1082.     available.  For example, if you removed the copy function (Alt-C in the
  1083.     standard SEE.MNU), you could still press the "C" key to perform a copy, but
  1084.     if you have not documented this feature, the user won't know about it.
  1085.  
  1086.     Nevertheless, you may wish to map the standard keys differently.  For
  1087.     example, you might want "R" to stand for "Repeat find", rather than using
  1088.     "A" for "find Again".  Moreover, you might want to completely disable a
  1089.     function, so that it can not be reached by any means.  To do this, you
  1090.     would remove it from the pull-down menu AND disable the standard key method
  1091.     of accessing the function.
  1092.  
  1093.     To override SEE's standard keys, you add a [STANDARD KEYS] section to the
  1094.     end of the menu (MNU) file.  (If this section is missing, SEE will use its
  1095.     default values.)
  1096.  
  1097.     We call this overriding process "standard key remapping". The [STANDARD
  1098.     KEYS] section specifies a list of standard (keyboard typeable) characters,
  1099.     and the token to which each one corresponds.  This is very similar to what
  1100.     you do when you alter the pull-down menus; in that case, each function is
  1101.     "mapped" (i.e. made to correspond to) a "token" letter, which SEE knows
  1102.     refers to a particular function.  (For example, the token "h" refers to the
  1103.     function "find Again" -- refer to the file SEE.MNU if this is not clear to
  1104.     you.)
  1105.  
  1106.     The [STANDARD KEYS] section must start with the label [STANDARD KEYS].
  1107.     After that, you can specify a list of standard (keyboard typeable)
  1108.     characters. On the next line, you specify the tokens to which each
  1109.     character corresponds. (This is known as "mapping standard characters to
  1110.     tokens").
  1111.  
  1112.     In remapping, uppercase letters are considered the same as lowercase
  1113.     letters, so there is no need to map both "A" and "a", since they are
  1114.     considered to be the same.  Also, Ctrl-A is considered the same as "A".
  1115.     (One exception to this rule:  Ctrl-I is always treated as Tab)
  1116.  
  1117.     In addition to remapping letter and number keys, you can also remap action
  1118.     keys (e.g. PgUp) and mouse actions (e.g. Click Right Button).  You
  1119.     represent these keys using the {symbol} convention.  Here are some useful
  1120.     values:
  1121.  
  1122.     CR       = {013}   Esc      = {027}   Space    = {032}   Mse_Up   = {128}
  1123.     Mse_Dn   = {129}   Mse_Left = {130}   Mse_Rght = {131}   Mse_BR   = {132}
  1124.     Mse_BL   = {133}   F1       = {187}   F2       = {188}   F3       = {189}
  1125.     F4       = {190}   F5       = {191}   F6       = {192}   F7       = {193}
  1126.     F8       = {194}   F9       = {195}   F10      = {196}   Arw_Up   = {200}
  1127.     Arw_Dn   = {208}   Arw_Left = {203}   Ctl_Left = {243}   Arw_Rght = {205}
  1128.     Ctl_Rght = {244}   PgUp     = {201}   PgDn     = {209}   Ctl_PgDn = {246}
  1129.     Home     = {199}   Ctl_Home = {247}   End      = {207}   Ctl_End  = {245}
  1130.     Tab      = {009}   BackTab  = {143}
  1131.  
  1132.     The maximum length of a definition line is 255 characters.  You can use
  1133.     several lines to perform all your remappings -- bearing in mind that they
  1134.     must appear in pairs:  a CHARACTER line must be followed by a SEE TOKEN
  1135.     line.  For enhanced readability, you can leave a null (empty) line between
  1136.     pairs of remapping definition lines.  You can also include comment lines
  1137.     (i.e. lines that start with the semi-colon character).
  1138.  
  1139.     You can also use spaces (" ") in either the CHARACTER or SEE TOKEN line to
  1140.     "pad out" your list; spaces are ignored.  This helps you line up the
  1141.     {symbols} with their corresponding tokens, which makes it much easier for
  1142.     you to remember which {symbol} goes with which token.
  1143.  
  1144.     The format of the lines should be self-evident from the example given
  1145.     below. Note that if you wish to map a character to NOTHING (i.e. no
  1146.     function at all), specify a tilde ("~") in the corresponding position.
  1147.  
  1148.     [STANDARD KEYS]
  1149.     CHARACTER 10245ABCDEFGHIJKLMNOPQRSTUVWXYZ/|?\#<>,.-_+=
  1150.     SEE TOKEN rswyyhKi~lg~~~~ioHoO~~hg~~VEF~FggggoEFEFEEFF
  1151.  
  1152.     CHARACTER {203}    {130}    {205}    {131}    {143}    {243}    {009}
  1153.     SEE TOKEN A        A        B        B        C        C        D
  1154.  
  1155.     CHARACTER {244}    {200}    {128}    {208}    {129}    {201}    {209}
  1156.     SEE TOKEN D        E        E        F        F        G        I
  1157.     
  1158.     In the example, we have mapped all the standard keys in the default way,
  1159.     with one exception:  the R key doesn't point to the "u" token (which is the
  1160.     "Ruler Toggle" function).  Rather, we have pointed it to the "h" token,
  1161.     which is the "Find Again" function.  In actual practice, you will usually
  1162.     define only those keys you wish to override; there is no reason to specify
  1163.     all characters and tokens.  Indeed, it is unlikely you would want to
  1164.     redefine the PgDn or Esc keys.
  1165.  
  1166.     A total of 80 keys can be mapped.  By default, there are 60 keys already
  1167.     mapped, so you can add 20 new keys.  Be careful, though, not to map a key
  1168.     that is already defined as a shortcut key; a key can't do two things at
  1169.     once.
  1170.  
  1171.     ------------------
  1172.     SEE COMMAND TOKENS
  1173.     ------------------
  1174.  
  1175.     Here is a list of the tokens, and the functions they perform:
  1176.  
  1177.     TOKEN  FUNCTION                       TOKEN  FUNCTION
  1178.     -----  ---------------------------    -----  ---------------------------
  1179.  
  1180.       $    Display CmdMacros help           #    Display Command Line help
  1181.       ^    Display Command Switch help      &    Display Key Stack help
  1182.       *    Display Override help            @    Display Scrolling help
  1183.       %    Display Shortcuts help
  1184.       
  1185.       g    Find given text                  O    Find given text, from top
  1186.       V    Find given text, previous        h    Re-find text
  1187.       K    Re-find text, previous           L    Return to last Find line
  1188.       o    Jump to line number
  1189.  
  1190.       w    Color, 25 line mode              y    Color, 43/50 line mode
  1191.       v    Monochrome, 25 line mode         x    Monochrome, 43/50 line mode
  1192.  
  1193.       r    Home - column 1                  p    Home - same column
  1194.       s    End - column 1                   q    End - Same column
  1195.       G    Page up                          I    Page down
  1196.       H    Page down, exit at end           E    Up arrow
  1197.       F    Down arrow                       A    Scroll 1 character right
  1198.       B    Scroll 1 character left          C    Scroll 5 characters right
  1199.       D    Scroll 5 characters right
  1200.  
  1201.       J    Internal diagnostic screen       d    Call SEESETUP program
  1202.       !    Display menu bar                 l    Eject printer page
  1203.       i    Start copy operation             z    Exit SEE
  1204.       m    Toggle printer code filter       u    Toggle ruler
  1205.       j    Toggle textify mode              ~    Do nothing
  1206.  
  1207.  
  1208.                          ---------------------------------
  1209.                          CONFIGURING FROM THE COMMAND LINE
  1210.                          ---------------------------------
  1211.  
  1212.     Sometimes you need a brief departure from the standard configuration
  1213.     settings.  For example, you might want to display a particularly important
  1214.     document in a different color, or you might want to change the default
  1215.     printer for a particular task.  You can, of course, set up multiple
  1216.     configuration (CFG) files -- see the explanation of /C for details -- but
  1217.     you can also pass quick changes on the command line.  While this is a bit
  1218.     cumbersome for manual use, it is a powerful tool when you call SEE from a
  1219.     program or a batch file.
  1220.  
  1221.     To temporarily change a setting, you use this format:
  1222.  
  1223.     SEE file /Ochange-list
  1224.  
  1225.     The format of the change-list (which can be up to 100 characters long) is:
  1226.  
  1227.     delimiter code delimiter value [delimiter code delimiter value] [...]
  1228.  
  1229.     For example, to change the the main viewing screen color to Yellow on Red
  1230.     (which will really get the readers attention!), you enter this command:
  1231.  
  1232.     SEE SEE.DOC /o!MVRGTX!Yr
  1233.  
  1234.     The exclamation mark (!) is the delimiter.  SEE.DOC is the file being
  1235.     displayed.  MVRGTX is the code meaning "Main View Screen, Regular Text". Yr
  1236.     is the color code for Yellow on Red. (For a table of color codes, start
  1237.     SEESETUP, select Color, then press F1)
  1238.  
  1239.     This change will remain in effect only as long as SEE is running.  If you
  1240.     want to make the change permanent, you can use the /W option (described
  1241.     later).
  1242.  
  1243.     You can specify more than one configuration change at once -- although you
  1244.     can only have one /O parameter.  Here is another example, which sets the
  1245.     color to Green on Blue and turns on the top-line ruler (instead of the
  1246.     usual file information display):
  1247.  
  1248.     SEE SEE.DOC /o=MVRgTx=Gb=UseRul=Y
  1249.  
  1250.     In this example, the delimiter is the equals sign (=).  You can use any
  1251.     delimiter except the following:
  1252.  
  1253.     |  <  >  "
  1254.  
  1255.     The first three have a special meaning to DOS, and the double-quote has a
  1256.     special meaning to SEE, as explained in the section "Spaces in Parameters".
  1257.     The example demonstrates that the codes can be in any case (UPPERCASE,
  1258.     lowercase or MixedCase).
  1259.  
  1260.     IMPORTANT NOTE:  The values you feed to SEE via the /O switch are given
  1261.     only a rudimentary evaluation.  It is possible to feed an "impossible"
  1262.     value (such as setting the LINES settings to 999).  When in doubt, consult
  1263.     the help screens available in the SEESETUP program which correspond to the
  1264.     items you wish to modify.
  1265.  
  1266.     Here are the configuration items you can change:
  1267.  
  1268.  
  1269.     ------------------
  1270.     COPYING OPERATIONS
  1271.     ------------------
  1272.                                                          MAXIMUM
  1273.     CODE    DESCRIPTION                                  LENGTH   TYPE OF INPUT
  1274.     ------  -------------------------------------------  -------  -------------
  1275.     PRTR    Default printer (LPT) for Copy-To operation     1     1 to 9
  1276.     PRTR?   Let the user change default printer?            1     Y or N
  1277.     CVT     Send text to printer Converted or As-is?        1     C or A
  1278.     CVT?    Let the user choose to convert or not?          1     Y or N
  1279.     COPYTO  Default copy destination, printer or file       1     P or F
  1280.     COPYT?  Let the user pick copy destination?             1     Y or N
  1281.     OVERWR  Overwrite or Append when copying to file?       1     O or A
  1282.     OVERW?  Let the user pick Overwrite or Append?          1     Y or N
  1283.     DFSVFL  Default name for file to write to?             50     File name
  1284.     DFSVF?  Let the user pick the file to write to?         1     Y or N
  1285.  
  1286.  
  1287.     ------------------
  1288.     STATUS INDICATIONS
  1289.     ------------------
  1290.                                                          MAXIMUM
  1291.     CODE    DESCRIPTION                                  LENGTH   TYPE OF INPUT
  1292.     ------  -------------------------------------------  -------  -------------
  1293.     BLTOP   Bottom line of screen at top of file           80     Decoded Text
  1294.     BLMID   Bottom line of screen at middle of file        80     Decoded Text
  1295.     BLEND   Bottom line of screen at end of file           80     Decoded Text
  1296.     BLALL   Bottom line when entire file fits on screen    80     Decoded Text
  1297.     EOFMRK  End of File Marker                             20     Decoded Text
  1298.  
  1299.     "Decoded Text" means text that allows the use of the {123} symbols, which
  1300.     are translated to their ASCII equivalent.  This lets you enter values that
  1301.     you can not type at the keyboard.  Note that the TOPLIN, MIDLIN and ENDLIN
  1302.     values can also be specified in the MNU file.  See the file SEESAMPL.MNU
  1303.     (included with the standard version of SEE) for a demonstration of the
  1304.     technique.
  1305.  
  1306.  
  1307.     --------------
  1308.     PRINTER SETUPS
  1309.     --------------
  1310.                                                          MAXIMUM
  1311.     CODE    DESCRIPTION                                  LENGTH   TYPE OF INPUT
  1312.     ------  -------------------------------------------  -------  -------------
  1313.     PRA     Printer (LPT) for which setup is designed       1     1 to 9
  1314.     PRASET  Initializing string to send to printer         40     Decoded Text
  1315.     PRAIN1  Instructions to user - line 1                  40     Text
  1316.     PRAIN2  Instructions to user - line 2                  40     Text
  1317.     PRAEND  Last string to send to printer                 40     Decoded Text
  1318.     PRA     Printer (LPT) for which setup is designed       1     1 to 9
  1319.     PRASET  Initializing string to send to printer         40     Decoded Text
  1320.     PRAIN1  Instructions to user - line 1                  40     Text
  1321.     PRAIN2  Instructions to user - line 2                  40     Text
  1322.     PRAEND  Last string to send to printer                 40     Decoded Text
  1323.     PRA     Printer (LPT) for which setup is designed       1     1 to 9
  1324.     PRASET  Initializing string to send to printer         40     Decoded Text
  1325.     PRAIN1  Instructions to user - line 1                  40     Text
  1326.     PRAIN2  Instructions to user - line 2                  40     Text
  1327.     PRAEND  Last string to send to printer                 40     Decoded Text
  1328.  
  1329.     "Decoded Text" means text that allows the use of the {123} symbols, which
  1330.     are translated to their ASCII equivalent.  This lets you enter values that
  1331.     you can not type at the keyboard.
  1332.  
  1333.  
  1334.     ---------------
  1335.     DISPLAY CONTROL
  1336.     ---------------
  1337.                                                          MAXIMUM
  1338.     CODE    DESCRIPTION                                  LENGTH   TYPE OF INPUT
  1339.     ------  -------------------------------------------  -------  -------------
  1340.     MONO    Use monochrome mode & mono display colors?      1     Y or N
  1341.     LINES   Lines per screen (0 = whatever is current)      1     0, 25, 43, 50
  1342.     USERUL  Start up with ruler on top line?                1     Y or N
  1343.     FINDTX  Default "find" text when user does a Find      20     Text
  1344.     ITXTFY  Use International Textify?                      1     Y or N
  1345.     STOPBT  Stop scrolling at bottom of file?               1     Y or N
  1346.  
  1347.     For LINES, note that 43 and 50 are equivalent.  If SEE is running on an EGA
  1348.     card, either 43 or 50 will display 43 lines.  If SEE is running on a VGA
  1349.     card, either value will display 50 lines.
  1350.  
  1351.  
  1352.     --------------
  1353.     COLOR SETTINGS
  1354.     --------------
  1355.  
  1356.     CODE    DESCRIPTION                                  LENGTH   TYPE OF INPUT
  1357.     ------  -------------------------------------------  -------  -------------
  1358.     EOFMCO  Main View Screen, End of File Marker           2/4    Color Codes
  1359.     EOFBCO  Main View Screen, Beyond End of File           2/4    Color Codes
  1360.     MVRGTX  Main View Screen, Standard Text                2/4    Color Codes
  1361.     MVFNTX  Main View Screen, Found Text                   2/4    Color Codes
  1362.     MVSTLL  Main View Screen, Top Line Labels              2/4    Color Codes
  1363.     MVSTLD  Main View Screen, Top Line Data                2/4    Color Codes
  1364.     PUINFT  Pop-up messages, Info, Standard Text           2/4    Color Codes
  1365.     PUINFB  Pop-up messages, Info, Border                  2/4    Color Codes
  1366.     PUINFH  Pop-up messages, Info, Highlighted Text        2/4    Color Codes
  1367.     PUINFL  Pop-up messages, Info, Lowlighted Text         2/4    Color Codes
  1368.     PUWRNT  Pop-up messages, Warning, Text                 2/4    Color Codes
  1369.     PUWRNB  Pop-up messages, Warning, Border               2/4    Color Codes
  1370.     PUQUET  Pop-up messages, Question, Standard Text       2/4    Color Codes
  1371.     PUQUEB  Pop-up messages, Question, Border              2/4    Color Codes
  1372.     PUQUEH  Pop-up messages, Question, Highlighted Text    2/4    Color Codes
  1373.     PUQUEI  Pop-up messages, Question, Input Text          2/4    Color Codes
  1374.     PMNRMT  Pull-down menus, Normal topic                  2/4    Color Codes
  1375.     PMLTR1  Pull-down menus, Quick letter, foreground      2/4    Color Codes
  1376.     PMMAIN  Pull-down menus, Main topic selected, bkgrnd   2/4    Color Codes
  1377.     PMMENU  Pull-down menus, Menu topic selected           2/4    Color Codes
  1378.     PMBORD  Pull-down menus, Menu borders, background      2/4    Color Codes
  1379.  
  1380.     Color codes can be specified either as two characters (e.g. Gr) or four
  1381.     characters (e.g. GrLk).  If you specify two characters, you will only
  1382.     change the color set and leave the monochrome set unaffected.  If you
  1383.     specify four characters, you will change both the color and monochrome
  1384.     settings.
  1385.  
  1386.     The color codes (which are case sensitive) are as follows:
  1387.  
  1388.     FOREGROUND OR BACKGROUND       MAY BE USED IN FOREGROUND ONLY
  1389.     ------------------------       ------------------------------
  1390.     k Black     b Blue             D Dark Gray     B Light Blue
  1391.     g Green     c Cyan             G Light Green   C Light Cyan
  1392.     r Red       m Magenta          R Light Red     M Light Magenta
  1393.     w Brown     L Light Gray       Y Yellow        W White
  1394.  
  1395.  
  1396.     ---------------
  1397.     COMPLEX EXAMPLE
  1398.     ---------------
  1399.  
  1400.     Here is a fairly complex example of the /O parameter which will radically
  1401.     change the appearance of SEE from its standard setup...
  1402.  
  1403.     /o:PMNRMT:Lk:PMLTR1:Yr:PMMAIN:Yk:PMMENU:Gb:PMBORD:Gr:USERUL:Y:MVRGTX:Yr
  1404.  
  1405.  
  1406.     ---------------------------------
  1407.     SAVING CHANGES WITH THE /W SWITCH
  1408.     ---------------------------------
  1409.  
  1410.     The /O parameter is generally used to make temporary changes.  However, if
  1411.     you add the /W switch to the command, SEE will write the changes to the
  1412.     configuration (CFG) file when it ends normally.
  1413.  
  1414.     There is one special situation using /O and /W:  if you do not specify a
  1415.     file, nothing will be displayed on the screen (unless there is an error).
  1416.     Normally, when you do not specify a file, SEE displays a menu of all the
  1417.     files in the current directory.  However, if it spots both the /O and /W
  1418.     parameters, it assumes that you wish to make a "quiet" change to the
  1419.     configuration.
  1420.  
  1421.     The benefit of this feature is that it allows you to give users a copy of
  1422.     SEE without giving them a copy of SEESETUP, yet still have the power to
  1423.     make permanent changes to their configuration.  This capability is most
  1424.     welcome by network administrators who are tired of bailing out users who
  1425.     made configuration changes -- thinking they knew what they were doing --
  1426.     only to get into trouble.  Thanks to the /W switch, the administrator can
  1427.     dictate a cryptic line over the phone -- asking the user to read it back
  1428.     to be sure, of course -- and install a change in an obscure manner that
  1429.     will not tempt the user to play around.
  1430.  
  1431.  
  1432.                                    --------------
  1433.                                    REQUIRED FILES
  1434.                                    --------------
  1435.  
  1436.     The information in this section is not important if you have a single-user
  1437.     license for SEE.  However, if you will be providing multiple users with
  1438.     SEE, you may wish to know which files are essential.
  1439.  
  1440.     The following files should be placed in the same directory as SEE.EXE:
  1441.  
  1442.     FILE NAME     NOTE  DESCRIPTION
  1443.     ------------- ----  -----------
  1444.     SET.SET         1   Created by the evaluation copy of SEE
  1445.     SERIAL#.SET     1   Registration file for the registered copy
  1446.     ORDER.FRM       1   Order form
  1447.     SEE.SBI         2   Help file for SEE (Index)
  1448.     SEE.SBT         2   Help file for SEE (Text)
  1449.     SEESETUP.SBI    3   Help file for SEE (Index)
  1450.     SEESETUP.SBT    3   Help file for SEE (Text)
  1451.     SEE.MNU         -   Pull-down menu definition
  1452.     SEE.CFG         4   Configuration file
  1453.  
  1454.     NOTE #1:  These files are only required by the evaluation and registered
  1455.               versions of SEE.  In copies covered by Distribution and Retail
  1456.               Licenses, these files are not required.
  1457.  
  1458.     NOTE #2:  These files are created by compiling a source (SBS) file, using a
  1459.               program named SBX, a copy of which is included with the Distri-
  1460.               bution and Retail Licenses.  These licenses also include a copy
  1461.               of the original SBS files for SEE.  These files are called up
  1462.               when the user selects Help from the pull-down menu in SEE.
  1463.  
  1464.     NOTE #3:  These files may be omitted if you are not including the setup
  1465.               program (SEESETUP.EXE).  These files are created by compiling a
  1466.               source (SBS) file, using a program named SBX, a copy of which is
  1467.               included with the Distribution and Retail Licenses.  These
  1468.               licenses also include a copy of the original SBS files for
  1469.               SEESETUP. These files are called up when the user presses the F1
  1470.               key in SEESETUP.
  1471.  
  1472.     NOTE #4:  In normal operation, SEE looks in the current directory for
  1473.               SEE.CFG.  If it does not find it there, it looks in the directory
  1474.               where SEE.EXE is located.  If it does not find it there, it will
  1475.               use "reasonable" default values that are appropriate under most
  1476.               conditions.  You can also use SEE's /C parameter to point to an
  1477.               alternative CFG file.
  1478.  
  1479. ::ERRORS
  1480.  
  1481.     ===========================================================================
  1482.                                     ERROR CODES
  1483.     ===========================================================================
  1484.  
  1485.  
  1486.     IMPORTANT NOTE:  When testing for a DOS ERRORLEVEL in a batch file, you
  1487.     must test the highest value first, since the command IF ERRORLEVEL is
  1488.     considered "true" if the ERRORLEVEL is the cited value or higher.  See
  1489.     your DOS manual for details.
  1490.  
  1491.     Both SEE and SEESETUP return an ERRORLEVEL of 255 when the help screen
  1492.     is displayed (e.g. by typing SEE /? at the DOS prompt).
  1493.  
  1494.                                     
  1495.                            ------------------------------
  1496.                            ERRORS WHILE READING MNU FILES
  1497.                            ------------------------------
  1498.  
  1499.     The following errors may appear while SEE is reading in a MNU file. All of
  1500.     these errors cause SEE to terminate with a DOS ERRORLEVEL of 255.
  1501.  
  1502.     Incomplete [BOTTOM LINES] line in <filename>
  1503.     Missing | in [BOTTOM LINES] line in <filename>
  1504.     Unrecognized type of [BOTTOM LINES] line in <filename>
  1505.     Different number of characters and tokens in [STANDARD KEYS] line
  1506.     Exceeded maximum of 80 [STANDARD KEYS] mappings
  1507.     Incomplete line in [STANDARD KEYS] section in <filename>
  1508.     Missing SEE TOKEN line in [STANDARD KEYS] section in <filename>
  1509.     Unrecognized line in [STANDARD KEYS] section in <filename>
  1510.  
  1511.     SEE will terminate with an ERRORLEVEL of 150 if it can not find the MNU
  1512.     file, or if for some other reason it can not be opened (e.g. insufficient
  1513.     file handles -- for a discussion of this problem, see the discussion of
  1514.     the FILES= value in your DOS manual's section on the CONFIG.SYS file.)
  1515.  
  1516.  
  1517.                         ------------------------------------
  1518.                         ERRORS GENERATED BY THE /F PARAMETER
  1519.                         ------------------------------------
  1520.  
  1521.     If No-Show text being sought by the /F parameter is not found, SEE will
  1522.     terminate with an ERRORLEVEL of 100.  (For an explanation of No-Show text,
  1523.     see the section about the /N parameter).
  1524.  
  1525.     If visible text being sought by /F is not found, SEE will display an
  1526.     warning message and will not terminate, unless you have told it to do so
  1527.     via SEESETUP (or specified this behaviour with the command line parameter
  1528.     /o:TOVFF:Y).  In such case, SEE will terminate with an ERRORLEVEL of 100.
  1529.  
  1530.  
  1531.                         ------------------------------------
  1532.                         ERRORS GENERATED BY THE /O PARAMETER
  1533.                         ------------------------------------
  1534.  
  1535.     SEE terminates with an ERRORLEVEL of 255 if you specify a /O code that it
  1536.     does not recognize, or if the value for the code is inappropriate.  For
  1537.     example, if you try to set the number of lines per screen to a non-numeric
  1538.     value (e.g. SEE READ.ME /O:LINES:XYZ), SEE will terminate.  However, SEE
  1539.     does NOT completely check the validity of /O parameters.  For example, it
  1540.     is possible to specify /O:LINES:999 but the result is not defined.  For
  1541.     more details on this subject, see the discussion of the /O parameter.
  1542.  
  1543.  
  1544.                                     -----------
  1545.                                     FILE ERRORS
  1546.                                     -----------
  1547.  
  1548.     SEE will terminate if there is a problem opening a file to read.  This
  1549.     termination happens only if the file was specified explicitly on the
  1550.     command line.  For example, if you enter SEE XYZ.TXT and the file is
  1551.     not present, SEE will terminate.  However, if you enter SEE *.TXT, and
  1552.     there is a problem opening one of the file selected from the menu, SEE
  1553.     will report the error but will not terminate.
  1554.  
  1555.     For a list of relevant error codes, see "Summary of Errorlevels"
  1556.  
  1557.     SEESETUP will terminate with an ERRORLEVEL of 60 if for some reason (such
  1558.     as a disk error) it can not write to the CFG file.  (If SEESETUP can not
  1559.     open the CFG file, it tries to create a copy, rather than terminating.)
  1560.  
  1561.     SEE will terminate with an ERRORLEVEL of 60 if you use the /W command-
  1562.     line switch to write the CFG file, and for some reason the file could not
  1563.     be written.
  1564.  
  1565.  
  1566.                                ----------------------
  1567.                                SUMMARY OF ERRORLEVELS
  1568.                                ----------------------
  1569.  
  1570.     This list does not include conditions that result in an ERRORLEVEL of
  1571.     255, since these are usually command-line errors or problems with the
  1572.     syntax of the MNU file.  In such cases, the error is described to the
  1573.     programmer before the program ends.
  1574.  
  1575.     ERRORLEVEL  REASON
  1576.     ----------  ------
  1577.         50      File could not be opened (usual reason: does not exist)
  1578.         51      File does exist, but it is empty (contains zero bytes)
  1579.         52      Insufficient memory
  1580.         53      Indeterminate file open error (report these to Pinnacle)
  1581.         60      SEE or SEESETUP could not write to the CFG file
  1582.        100      /F failed in No-Show mode
  1583.        100      /F did not find visible text (see discussion of /O:TOVFF)
  1584.        150      SEE could not open the MNU file or it is empty
  1585.        151      SEE could not open the SBx files (SBT/SBI)
  1586.  
  1587.  
  1588.